<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.5"/>
<title>prd: xprd_example.c File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
  $(window).load(resizeHeight);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="HTML_custom.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="xlogo_bg.png"/></td>
  <td style="padding-left: 0.5em;">
   <div id="projectname">prd
   </div>
   <div id="projectbrief">Vitis Drivers API Documentation</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Overview</span></a></li>
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="globals.html"><span>APIs</span></a></li>
      <li><a href="files.html"><span>File&#160;List</span></a></li>
      <li><a href="pages.html"><span>Examples</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('xprd__example_8c.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#define-members">Macros</a> &#124;
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">xprd_example.c File Reference</div>  </div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">Overview</h2>
<div class="textblock"><p>This file contains an example using the <a class="el" href="struct_x_prd.html" title="The XPrd instance data structure. ">XPrd</a> driver to test the registers on the device. </p>
<dl class="section note"><dt>Note</dt><dd>None</dd></dl>
<p>MODIFICATION HISTORY: </p>
<pre>
Ver      Who   Date           Changes
</p>
<hr/>
<p>
1.0   ms    07/14/2016     First Release
      ms    04/05/2017     Modified comment lines notation in functions to
                           avoid unnecessary description displayed
                           while generating doxygen.
2.2   Nava  06/22/2023     Added support for system device-tree flow.
</pre> </div><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:a3d9140c35fd5787425c30bde913ebe47"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xprd__example_8c.html#a3d9140c35fd5787425c30bde913ebe47">XPRD_DEVICE_ID</a>&#160;&#160;&#160;XPAR_PR_DECOUPLER_0_DEVICE_ID</td></tr>
<tr class="memdesc:a3d9140c35fd5787425c30bde913ebe47"><td class="mdescLeft">&#160;</td><td class="mdescRight">The following constants map to the XPAR parameters created in the xparameters.h file.  <a href="#a3d9140c35fd5787425c30bde913ebe47">More...</a><br/></td></tr>
<tr class="separator:a3d9140c35fd5787425c30bde913ebe47"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a410824c3df6d31386f454dee2c709dcb"><td class="memItemLeft" align="right" valign="top">u32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xprd__example_8c.html#a410824c3df6d31386f454dee2c709dcb">XPrd_Example</a> (u16 DeviceId)</td></tr>
<tr class="memdesc:a410824c3df6d31386f454dee2c709dcb"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function does a minimal test on the PR Decoupler device and driver as a design example.  <a href="#a410824c3df6d31386f454dee2c709dcb">More...</a><br/></td></tr>
<tr class="separator:a410824c3df6d31386f454dee2c709dcb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7d27eeac5a2c92eea613b73500530488"><td class="memItemLeft" align="right" valign="top">u32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xprd__example_8c.html#a7d27eeac5a2c92eea613b73500530488">XPrd_TestDecouplerState</a> (XGpio DecouplerGpio)</td></tr>
<tr class="memdesc:a7d27eeac5a2c92eea613b73500530488"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function is used to test the SetDecouplerState and GetDecouplerState.  <a href="#a7d27eeac5a2c92eea613b73500530488">More...</a><br/></td></tr>
<tr class="separator:a7d27eeac5a2c92eea613b73500530488"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a840291bc02cba5474a4cb46a9b9566fe"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xprd__example_8c.html#a840291bc02cba5474a4cb46a9b9566fe">main</a> (void)</td></tr>
<tr class="memdesc:a840291bc02cba5474a4cb46a9b9566fe"><td class="mdescLeft">&#160;</td><td class="mdescRight">This is the main function to call the example.  <a href="#a840291bc02cba5474a4cb46a9b9566fe">More...</a><br/></td></tr>
<tr class="separator:a840291bc02cba5474a4cb46a9b9566fe"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a class="anchor" id="a3d9140c35fd5787425c30bde913ebe47"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XPRD_DEVICE_ID&#160;&#160;&#160;XPAR_PR_DECOUPLER_0_DEVICE_ID</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>The following constants map to the XPAR parameters created in the xparameters.h file. </p>
<p>They are defined here such that a user can easily change all the needed parameters in one place. </p>

<p>Referenced by <a class="el" href="xprd__example_8c.html#a840291bc02cba5474a4cb46a9b9566fe">main()</a>.</p>

</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="a840291bc02cba5474a4cb46a9b9566fe"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int main </td>
          <td>(</td>
          <td class="paramtype">void&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This is the main function to call the example. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">None.</td><td></td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li>XST_SUCCESS if successful.</li>
<li>XST_FAILURE if failed.</li>
</ul>
</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p>References <a class="el" href="xprd__example_8c.html#a3d9140c35fd5787425c30bde913ebe47">XPRD_DEVICE_ID</a>, and <a class="el" href="xprd__example_8c.html#a410824c3df6d31386f454dee2c709dcb">XPrd_Example()</a>.</p>

</div>
</div>
<a class="anchor" id="a410824c3df6d31386f454dee2c709dcb"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u32 XPrd_Example </td>
          <td>(</td>
          <td class="paramtype">u16&#160;</td>
          <td class="paramname"><em>DeviceId</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function does a minimal test on the PR Decoupler device and driver as a design example. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">DeviceId</td><td>is the XPAR_&lt;prd_instance&gt;_DEVICE_ID value from xparameters.h.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li>XST_SUCCESS if successful</li>
<li>XST_FAILURE if failed</li>
</ul>
</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p>References <a class="el" href="group__prd.html#ga424f5c8b2cad657a5aea953ba959be55">XPrd_CfgInitialize()</a>, <a class="el" href="group__prd.html#ga7a83aa6940de765c091dfd07df308ac2">XPrd_LookupConfig()</a>, <a class="el" href="group__prd.html#gaf18335c2976ab9b7c9d12a5a0c0a450c">XPrd_SelfTest()</a>, and <a class="el" href="xprd__example_8c.html#a7d27eeac5a2c92eea613b73500530488">XPrd_TestDecouplerState()</a>.</p>

<p>Referenced by <a class="el" href="xprd__example_8c.html#a840291bc02cba5474a4cb46a9b9566fe">main()</a>.</p>

</div>
</div>
<a class="anchor" id="a7d27eeac5a2c92eea613b73500530488"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u32 XPrd_TestDecouplerState </td>
          <td>(</td>
          <td class="paramtype">XGpio&#160;</td>
          <td class="paramname"><em>DecouplerGpio</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function is used to test the SetDecouplerState and GetDecouplerState. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">DecouplerGpio</td><td>is the Instance of the GPIO that's connected to the USR_ACCESS primitive.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li>XST_SUCCESS if successful</li>
<li>XST_FAILURE if failed</li>
</ul>
</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p>References <a class="el" href="group__prd.html#gad37688cbdb9d0b50c481132f6f05cee0">XPrd_GetDecouplerState()</a>, and <a class="el" href="group__prd.html#gacb64d55940567d71186233e1e230c0d0">XPrd_SetDecouplerState()</a>.</p>

<p>Referenced by <a class="el" href="xprd__example_8c.html#a410824c3df6d31386f454dee2c709dcb">XPrd_Example()</a>.</p>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
	<p class="footer">&copy; Copyright 2015-2022 Xilinx, Inc. All Rights Reserved.</p>
	<p class="footer">&copy; Copyright 2022-2023 Advanced Micro Devices, Inc. All Rights Reserved.</p>
</div>
</body>
</html>
